Resource URL: /platform/<<version=3>>/iiq/instances/<IIQ_IP>

    Overview: Registration service for InsightIQ to register itself with the
              OneFS cluster its monitoring.

     Methods: GET, PUT, DELETE

********************************************************************************

Method GET: Get InsightIQ instance monitoring this OneFS cluster.

       URL: GET /platform/<<version=3>>/iiq/instances/<IIQ_IP>

There are no query arguments for this method.

GET response body schema:
{
  "type": [
    {
      "additionalProperties": false, 
      "type": "object", 
      "description": "A list of errors that may be returned.", 
      "properties": {
        "errors": {
          "items": {
            "additionalProperties": false, 
            "type": "object", 
            "description": "An object describing a single error.", 
            "properties": {
              "field": {
                "type": "string", 
                "description": "The field with the error if applicable."
              }, 
              "message": {
                "type": "string", 
                "description": "The error message."
              }, 
              "code": {
                "type": "string", 
                "description": "The error code."
              }
            }
          }, 
          "type": "array"
        }
      }
    }, 
    {
      "additionalProperties": false, 
      "type": "object", 
      "properties": {
        "iiq_instance": {
          "minItems": 0, 
          "items": {
            "type": "object", 
            "properties": {
              "monitoring_state": {
                "type": "string", 
                "description": "InsightIQ's monitoring state of the OneFS cluster."
              }, 
              "node_ip": {
                "type": "string", 
                "description": "IP address of the OneFS node sharing a TCP session with InsightIQ."
              }, 
              "dns_name": {
                "type": [
                  "string", 
                  "null"
                ], 
                "description": "InsightIQ domain name."
              }, 
              "last_reg_time": {
                "type": "integer", 
                "description": "Unix timestamp for the last time InsightIQ registered with the OneFS cluster."
              }, 
              "version": {
                "type": "string", 
                "description": "InsightIQ release version."
              }, 
              "ip": {
                "type": "string", 
                "description": "InsightIQ IP address."
              }, 
              "active_reg_time": {
                "type": "integer", 
                "description": "Unix timestamp for start of InsightIQ's active registration period."
              }, 
              "first_reg_time": {
                "type": "integer", 
                "description": "Unix timestamp for when InsightIQ began monitoring the OneFS cluster."
              }
            }
          }, 
          "type": "array", 
          "maxItems": 4294967295
        }
      }
    }
  ]
}

********************************************************************************

Method PUT: Update InsightIQ instance registration.

       URL: PUT /platform/<<version=3>>/iiq/instances/<IIQ_IP>

There are no query arguments for this method.

Required PUT request body fields:
monitoring_state

PUT request body schema:
{
  "type": "object", 
  "properties": {
    "monitoring_state": {
      "required": true, 
      "type": "string", 
      "description": "InsightIQ's monitoring state of the OneFS cluster."
    }, 
    "dns_name": {
      "type": [
        "string", 
        "null"
      ], 
      "description": "InsightIQ domain name."
    }, 
    "version": {
      "type": "string", 
      "description": "InsightIQ release version."
    }, 
    "node_ip": {
      "type": "string", 
      "description": "IP address of the OneFS node sharing a TCP session with InsightIQ."
    }
  }
}

There is no JSON response body for this method.

********************************************************************************

Method DELETE: Delete InsightIQ instance registration.

          URL: DELETE /platform/<<version=3>>/iiq/instances/<IIQ_IP>

There are no query arguments for this method.

There is no JSON response body for this method.
